Marks the end of a group. Any group that is created by adding a ConfigGroup should be terminated by adding a Pop on the last entry in that group. This annotation is repeatable, Annotate a setting multiple times if it is the end of multiple nested groups simultaneously.

Functions

anchorEntry

open override fun anchorEntry(anchor: EntryAnchor.Anchor): EntryAnchor.Anchor

anchorId

open override fun anchorId(scope: String): String

createEntry

open override fun createEntry(context: EntryCreator.CreatorContext): List<EntryCreator.Creator>

Builds one or more DynamicListWidget.Entry from provided CreatorContext. These entries are used to build config GUIs, being the "building block" of the settings list.

description

open fun description(fallback: String? = null): MutableText

The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered.

descriptionKey

open override fun descriptionKey(): String

translation key of this Translatable's description. the "description" in-game, the descriptions Enchantment Descriptions adds to enchantment tooltips are a good example.

getEntryKey

open override fun getEntryKey(): String

hasDescription

open fun hasDescription(): Boolean

Whether this Translatable has a valid description

hasPrefix

open fun hasPrefix(): Boolean

Whether this Translatable has a valid prefix

hasTranslation

open fun hasTranslation(): Boolean

Whether this Translatable has a valid translation

prefix

open fun prefix(fallback: String? = null): MutableText

The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered.

prefixKey

open override fun prefixKey(): String

translation key of this Translatable's inline prefix text. Unlike descriptions, which are usually displayed in-tooltips, prefixes are displayed inline in the config screen itself

prepare

open override fun prepare(scope: String, groups: LinkedList<String>, annotations: List<Annotation>, globalAnnotations: List<Annotation>)

Called in the prepare stage of screen building to perform any necessary pre-entry-creation tasks.

setEntryKey

open override fun setEntryKey(key: String)

translation

open fun translation(fallback: String? = null): MutableText

The translated Text name from the translationKey. Falls back to the implementing classes Simple Name (non-translated)

translationKey

open override fun translationKey(): String

translation key of this Translatable. the "name" in-game